Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add docstrings on datastore type utils #13728

Merged
merged 3 commits into from
Aug 19, 2024

Conversation

svidgen
Copy link
Member

@svidgen svidgen commented Aug 19, 2024

Description of changes

Add docstrings on the exposed type util functions so that they're represented and/or hidden in customer-facing docs correctly.

For most of these utils, that means explicitly marking them as @private to hide them from docs generation. It seemed easy enough to add a little context on the meaning of the return types for most of these as well, so that's included, but should be hidden from customer docs -- internal context only.

syncExpression is intended for customer consumption, so a description intended for customer consumption with sample code (borrowed from docs site) has been added.

Issue #, if available

Description of how you validated changes

Docstring changes only.

Checklist

  • PR description included
  • yarn test passes
  • Unit Tests are changed or added
  • Relevant documentation is changed or added (and PR referenced)

Checklist for repo maintainers

  • Verify E2E tests for existing workflows are working as expected or add E2E tests for newly added workflows
  • New source file paths included in this PR have been added to CODEOWNERS, if appropriate

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@svidgen svidgen requested a review from a team as a code owner August 19, 2024 14:46
@svidgen svidgen merged commit 6aaf4a0 into aws-amplify:main Aug 19, 2024
30 checks passed
@svidgen svidgen deleted the add-ds-type-util-docstrings branch August 19, 2024 15:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants